Customer Cards

View a customer's loyalty card progress

Customer cards represent a customer’s instance of a loyalty card template. They track stamp progress, status, and wallet pass installation. Use these endpoints to view a customer’s enrolled loyalty cards and their current progress toward rewards.

index

GET /api/v1/accounts/:account_id/customers/:customer_id/customer_cards

List customer cards

Returns all loyalty cards enrolled for a specific customer, including stamp progress, status, wallet pass installation state, and wallet pass URLs (apple_wallet_url and google_wallet_url) that you can use to let customers add their loyalty card to Apple Wallet or Google Wallet from your own app or website.

Parameters

Name	Type	Required	Description
`account_id`	Must be a number.	Required	Store (account) ID
`customer_id`	Must be a number.	Required	Customer ID

Error Codes

Code	Description
`401`	Unauthorized – invalid or missing API token
`404`	Store or customer not found

show

GET /api/v1/accounts/:account_id/customers/:customer_id/customer_cards/:id

Show a customer card

Returns detailed information about a specific customer card, including stamp progress, a list of rewards the customer has earned enough stamps to redeem, and wallet pass URLs (apple_wallet_url and google_wallet_url) for adding the card to Apple Wallet or Google Wallet.

Parameters

Name	Type	Required	Description
`account_id`	Must be a number.	Required	Store (account) ID
`customer_id`	Must be a number.	Required	Customer ID
`id`	Must be a number.	Required	Customer card ID

Error Codes

Code	Description
`401`	Unauthorized – invalid or missing API token
`404`	Store, customer, or customer card not found

stamp

POST /api/v1/accounts/:account_id/customers/:customer_id/customer_cards/:id/stamp

Add stamps

Adds stamps to a customer’s loyalty card. Triggers ledger entries, wallet pass updates, and push notifications. Pass skip_notifications to stamp silently.

Parameters

Name	Type	Required	Description
`account_id`	Must be a number.	Required	Store (account) ID
`customer_id`	Must be a number.	Required	Customer ID
`id`	Must be a number.	Required	Customer card ID
`stamps`	Must be a number.	Required	Number of stamps to add (e.g. 1, 3)
`skip_notifications`	Must be one of: `true`, `false`, `1`, `0`.	Optional	When true, stamp changes bypass notifications

Error Codes

Code	Description
`401`	Unauthorized – invalid or missing API token
`404`	Store, customer, or customer card not found
`422`	Validation failed – check `errors` for details

redeem

POST /api/v1/accounts/:account_id/customers/:customer_id/customer_cards/:id/redeem

Redeem a reward

Redeems a reward for a customer, deducting the required stamps from their card. The customer must have enough stamps on this card to cover the reward’s cost. Triggers wallet pass updates and push notifications.

Parameters

Name	Type	Required	Description
`account_id`	Must be a number.	Required	Store (account) ID
`customer_id`	Must be a number.	Required	Customer ID
`id`	Must be a number.	Required	Customer card ID
`reward_id`	Must be a number.	Required	Reward ID to redeem

Error Codes

Code	Description
`401`	Unauthorized – invalid or missing API token
`404`	Store, customer, customer card, or reward not found
`422`	Redemption failed – not enough stamps or reward inactive